Procédure étapes par étapes

  • Etape 1 : Créer un projet sur Gitlab pour une application ou de la documentation.

  • Etape 2 : Réaliser ses documentations sous un format ".adoc" soit avec un simple éditeur de texte ou le logiciel ASCII Doc FX (asciidocfx.com).

  • Etape 3 : Configurer la CI avec le fichier .gitlab-ci (ci-dessous) placé à la racine du projet.

    • Voici un exemple du fichier cité en étape 3

image: asciidoctor/docker-asciidoctor
pdf:
    stage: build
    script:
        - asciidoctor-pdf -D public documentation.adoc
        - asciidoctor-pdf -D public <votre documentation.adoc>
    only:
        - master
    artifacts:
        name: "documentation-pdf"
        paths:
            - public/

pages:
    stage: deploy
    script:
        - asciidoctor -o index.html -D public documentation.adoc
        - asciidoctor -o <nom de votre fichier.html> -D public <votre documentation.adoc>
    only:
        - master
    artifacts:
        name: "documentation-pdf"
        paths:
            - public/

1. Fonctionnement

  • Le fichier gitlab-ci.yml créer deux fichiers (Un fichier PDF et un fichier html de la docuentation en ASCII Doc)

  • A chaque nouvelle documentation crée, il faut mettre à jour le fichier gitlab-ci.yml

  • Chaque modifications de documentation existante (c’est à dire déclarée dans le fichier gitlab-ci.yml) l’entièreté du projet est régénérée (Démarrage d’un pipeline)